Python project using VSCode devcontainer

#python   #vscode   #dev container   #docker  

---

Table of Content

Python project using VSCode devcontainer

Multistage

• Create multistage docker
  • base
  • dev
• Set devcontainer target attribute to requested target

FROM ubuntu:22.04 as python_base
...
FROM python_base as python_dev
...

{
    "name": "python-dev",
    "build": {
        "dockerfile": "Dockerfile",
        "context": "..",
        "target": "python_dev"
    }
}

build multistage docker

docker build --target development

---

Permission

• Dockerfile: Add none root user (named user)
• Set devcontainer login as that user

Dockerfile

ARG USERNAME=user
ARG USER_UID=1000
ARG USER_GID=1000

RUN groupadd --gid $USER_GID $USERNAME \
    && useradd -s /bin/bash --uid $USER_UID --gid $USER_GID -m $USERNAME \
    && apt-get update \
    && apt-get install -y sudo tzdata \
    && echo $USERNAME ALL=\(root\) NOPASSWD:ALL > /etc/sudoers.d/$USERNAME\
    && chmod 0440 /etc/sudoers.d/$USERNAME \
    && rm -rf /var/lib/apt/lists/* 

```json title=”devcontainer.json “remoteUser”: “user”,

!!! note "remoteUser vs containerUser"
    - **remoteUser**: The user VS Code Server will be started with. The default is the same user as the container.
    - **containerUser**: The user the container will be started with. The default is the user on the Docker image.

---

## requirements
There at lest two option to install `requirement.txt`

- **Option 1**: Install `requirement.txt` using `devcontainer.json` property like `postCreateCommand`

```json title="devcontainer.json"
{
    "postCreateCommand": "pip install -r /workspaces/py_docker_tutorial/requirements-dev.txt",
}

• Option 2: Install requirements as docker layer

Dockerfile

COPY ./requirements.txt /tmp/requirements.txt
COPY ./requirements-dev.txt /tmp/requirements-dev.txt
RUN pip install --no-`cache-dir --upgrade -r /home/user/requirements-dev.txt

---

develop

• Register the project

pip install --prefix=~/.local -e .

build wheel and deb

RUN apt-get update && \
    apt-get install -y \
        python3-all \
        debhelper \
        dh-python \
        python3-stdeb \
        locales \
        locales-all \
        && rm -rf /var/lib/apt/lists/*

vscode tasks

tasks.json

"tasks": [
        {
            "label": "build deb",
            "type": "shell",
            "command": "python3 setup.py --command-packages=stdeb.command bdist_deb",
            "problemMatcher": []
        },
        {
            "label": "build wheel",
            "type": "shell",
            "command": "python3 setup.py bdist_wheel",
            "problemMatcher": []
        },

    ]

build output folder

• deb: deb_dist folder
• wheel: dist folder

---

Testing

• Install pytest (requirements-dev.txt)
• config vscode

devcontainer.json

{
    "customizations": {
        "vscode": {
            "settings": {
                "python.testing.pytestArgs": [
                                "tests"
                            ],
                "python.testing.unittestEnabled": false,
                "python.testing.pytestEnabled": true
            }
        }
    }
}

---

clean

• Clean Task

.vscode/tasks.json

{
    "label": "clean",
    "type": "shell",
    "command": "/usr/bin/bash -x scripts/clean.sh",
    "problemMatcher": []
}

scripts/clean.sh

rm -rf deb_dist
rm -rf dist
find . | grep -E "(/__pycache__$|\.pyc$|\.pyo$)" | xargs rm -rf

run bash script without execute permission set

bash -x scripts/clean.sh

---

python tools

• mypy
• formatter (black, isort)
• flake8 (linter)

---

VSCode extensions

• Python
• Tabout
• Code Spell Checker
• Tasks

TabOut

Tab out quotes, brackets. etc marketplace

Code Spell Checker

Spelling checker for source code marketplace

Tasks

Load VSCode Tasks into Status Bar. marketplace

---

TODO

docker-compose

"dockerComposeFile": "docker-compose.yaml",
"service": "app",
"workspaceFolder": "/workspace",

References

• devcontainer.json schema
• Variables Reference